<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>

        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title>Directory Helper : CodeIgniter User Guide</title>

        <style type='text/css' media='all'>@import url('../userguide.css');</style>
        <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />

        <script type="text/javascript" src="../nav/nav.js"></script>
        <script type="text/javascript" src="../nav/prototype.lite.js"></script>
        <script type="text/javascript" src="../nav/moo.fx.js"></script>
        <script type="text/javascript" src="../nav/user_guide_menu.js"></script>

        <meta http-equiv='expires' content='-1' />
        <meta http-equiv= 'pragma' content='no-cache' />
        <meta name='robots' content='all' />
        <meta name='author' content='ExpressionEngine Dev Team' />
        <meta name='description' content='CodeIgniter User Guide' />

    </head>
    <body>

        <!-- START NAVIGATION -->
        <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
        <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
        <div id="masthead">
            <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
                <tr>
                    <td><h1>CodeIgniter User Guide Version 2.2.0</h1></td>
                    <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
                </tr>
            </table>
        </div>
        <!-- END NAVIGATION -->


        <!-- START BREADCRUMB -->

        <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
            <tr>
                <td id="breadcrumb">
                    <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
                    <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
                    Directory Helper
                </td>
                <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="ellislab.com/codeigniter/user-guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
            </tr>
        </table>
        <!-- END BREADCRUMB -->

        <br clear="all" />


        <!-- START CONTENT -->
        <div id="content">


            <h1>Directory Helper</h1>

            <p>The Directory Helper file contains functions that assist in working with directories.</p>


            <h2>Loading this Helper</h2>

            <p>This helper is loaded using the following code:</p>
            <code>$this->load->helper('directory');</code>

            <p>The following functions are available:</p>

            <h2>directory_map('<var>source directory</var>')</h2>

            <p>This function reads the directory path specified in the first parameter
                and builds an array representation of it and all its contained files. Example:</p>

            <code>$map = directory_map('./mydirectory/');</code>

            <p class="important"><strong>Note:</strong> Paths are almost always relative to your main index.php file.</p>

            <p>Sub-folders contained within the directory will be mapped as well.  If you wish to control the recursion depth,
                you can do so using the second parameter (integer). A depth of 1 will only map the top level directory:</p>

            <code>$map = directory_map('./mydirectory/', 1);</code>

            <p>By default, hidden files will not be included in the returned array.  To override this behavior,
                you may set a third parameter to <var>true</var> (boolean):</p>

            <code>$map = directory_map('./mydirectory/', FALSE, TRUE);</code>

            <p>Each folder name will be an array index, while its contained files will be numerically indexed.
                Here is an example of a typical array:</p>

            <code>Array<br />
                (<br />
                &nbsp;&nbsp;&nbsp;[libraries] => Array<br />
                &nbsp;&nbsp;&nbsp;(<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[0] => benchmark.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[1] => config.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[database] => Array<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[0] => active_record.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[1] => binds.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[2] => configuration.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[3] => connecting.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[4] => examples.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[5] => fields.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[6] => index.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[7] => queries.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;)<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[2] => email.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[3] => file_uploading.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[4] => image_lib.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[5] => input.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[6] => language.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[7] => loader.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[8] => pagination.html<br />
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[9] => uri.html<br />
                )</code>







        </div>
        <!-- END CONTENT -->


        <div id="footer">
            <p>
                Previous Topic:&nbsp;&nbsp;<a href="date_helper.html">Date Helper</a>
                &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
                <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
                <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
                Next Topic:&nbsp;&nbsp;<a href="download_helper.html">Download Helper</a>
            </p>
            <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2014 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
        </div>

    </body>
</html>